/**
 * Software License, Version 1.0
 *
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 *
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 *
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University.  For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering,
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 *
 *
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of
 * any other entity.  Indiana University disclaims any liability to any
 * recipient for claims brought by any other entity based on infringement of
 * intellectual property rights or otherwise.
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.matching.rtp;

import java.util.ArrayList;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Iterator;

import cgl.narada.protocol.Destinations;
import cgl.narada.protocol.RtpProfilePropagation;


/**
   This class implements the rtp matching algorithm. This provides methods to
   add a subscription and also to remove interest in a subscription predicate.
   The matching algorithm should also be able to compute destinations.

   @author Shrideep Pallickara
   $Revision$
   $Date$
*/


public class ClientRtpMatching
  implements RtpMatchingTree, RtpMatchingDebugFlags {
  /** Profile Propagation Handler */
  private RtpProfilePropagation rtpPropagate;

  /** The unit level for this matching tree */
  private int unitLevel;

  /** The system level */
  private int systemLevel;
  /** The destination for this node */
  Destinations thisDestination;

  /** contains a mapping of profileId's to a given destination */
  private Hashtable destinationsInfo;
  /** contains a mapping of destinations associated with a given profile */
  private Hashtable profilesAndDestinations;

  /** Mapping of profiles Id's to individual destinations */
  private Hashtable profileIds;

  private String moduleName = "ClientRtpMatching: ";

  /** The RtpMatching constructor */
  public ClientRtpMatching(int unitLevel, int systemLevel,
			   RtpProfilePropagation rtpPropagate) {
    this.unitLevel = unitLevel;
    this.systemLevel = systemLevel;
    this.rtpPropagate = rtpPropagate;
    destinationsInfo = new Hashtable();
    profilesAndDestinations = new Hashtable();
    profileIds = new Hashtable();
  }

  /** This method returns the level assocaited with this matching tree. A
      node could be a gateway at multiple levels. How it handles destinations
      at different levels, and propagates destinations at different levels is
      dicatated by the level of the matching tree which computes the
      destinations and initiates profile propagation changes.
      @return The level of the matching tree.
  */
  public int getMatchingLevel() {
    return unitLevel;
  }

  /** This method sets the destination address for this node */
  public void setNodeDestination(Destinations destination) {
    thisDestination = destination;
  }

  /** This method adds a subscription profile to the matching tree
      @param profile The profile comprising the subscription and
      the destination assocaited with the subscription.  */
  public void addSubscriptionProfile(RtpProfile rtpProfile) {
    Integer destination = new Integer(rtpProfile.getDestination());
//    Integer profileKey = new Integer(rtpProfile.getSubscription());
    Long profileKey = new Long(rtpProfile.getSubscription());
    String profileId = rtpProfile.getProfileId();
    if (profileId == null) {
      System.out.println(moduleName + "Unacceptable profileID ["
			 + profileId + "]");
      return;
    }
    if (profileIds.containsKey(profileId)) {
      System.out.println(moduleName + rtpProfile + "=>>>Already registered");
      return;
    }
    profileIds.put(profileId, rtpProfile);

    /** Update the profile ids associated with a destination. If destination is
	a new one, create a new hashtable for profile ids to be stored and then
	associate this hashtable with the destination */
    if (destinationsInfo.containsKey(destination)) {
      ((Hashtable)destinationsInfo.get(destination)).put(profileId, profileId);
    } else {
      Hashtable _profileIds = new Hashtable();
      _profileIds.put(profileId, profileId);
      destinationsInfo.put(destination, _profileIds);
    }

    /** Update the destinations associated with a profile. If the profile is
	a new one, create a new hashtable for the destinations to be stored and
	then associate this hashtable with the profile */
    if (profilesAndDestinations.containsKey(profileKey)) {
       ((ArrayList)profilesAndDestinations.get(profileKey)).add(destination);
       //       ((Hashtable)profilesAndDestinations.get(profileKey)).put(destination, destination);
    } else {
       ArrayList destinations = new ArrayList();
       destinations.add(destination);
       profilesAndDestinations.put(profileKey, destinations);
//       Hashtable _destinations = new Hashtable();
//       _destinations.put(destination, destination);
//       profilesAndDestinations.put(profileKey, _destinations);
    }

  }

  public void removeSubscriptionProfile(RtpProfile rtpProfile) {
    removeProfileWithId(rtpProfile.getProfileId());
  }

  public void removeProfilesForDestination(Object clientIdentifier) {
    if (!destinationsInfo.containsKey(clientIdentifier)) {
        if (ClientRtpMatching_Debug) {
            System.out.println("ClientRtpMatching: Not aware of destination [" +
			 clientIdentifier +
			 "] submitted for removal from matching tree");
        }
      return;
    }

    Hashtable profileIdsToRemove =
      (Hashtable) destinationsInfo.get(clientIdentifier);
    /**Enumeration e = profileIdsToRemove.keys();
    while (e.hasMoreElements()) {
      Object _removeId = e.nextElement();
      removeProfileWithId(_removeId);
    }*/
   Iterator e = profileIdsToRemove.keySet().iterator();
   while (e.hasNext()) {
     Object _removeId = e.next();
     removeProfileWithId(_removeId);
   }

  }


  /** This method removes a subscription profile */
  public void removeProfileWithId(Object profileId) {
    if (profileId == null) {
      System.out.println(moduleName +  "ProfileId for removal is null");
      return;
    }
    if (!profileIds.containsKey(profileId)) {
      /** This profile has of course been processed before.*/
      System.out.println(moduleName +
			 "Trying to remove non-existent profileId");
      return;
    }

    RtpProfile rtpProfile = (RtpProfile)profileIds.get(profileId);
    Long profileKey = new Long(rtpProfile.getSubscription());
//    Integer profileKey = new Integer(rtpProfile.getSubscription());
    Integer destination = new Integer(rtpProfile.getDestination());

    if (profilesAndDestinations.containsKey(profileKey)) {
//       Hashtable _dests = (Hashtable)profilesAndDestinations.get(profileKey);
       ArrayList destinations = (ArrayList)profilesAndDestinations.get(profileKey);
      if (destinations.contains(destination)) {
         destinations.remove(destination);
      }
      /** If the destinations associated with a profile is reduced to
	  zero, remove the profile from the list of profiles. */
      if (destinations.size() == 0) {
	profilesAndDestinations.remove(profileKey);
      }
    }

    /** Remove the profileId from the list of profileId's being maintainied */
    profileIds.remove(profileId);
  }

  public void propagateChangesToHigherLevels(RtpProfile rtpProfile,
					     boolean addProfile) {
    /** The first step ofcourse is to replace lower level destinations with
	the destination ID at the next higher level */
    if (ClientRtpMatching_Debug) {
      System.out.println("The destination associated with profile " +
			 rtpProfile.getSubscription() + " is " +
			 rtpProfile.getDestination());
    }
    int temp = unitLevel;
    int tempDest;
    for (;temp < systemLevel;) {
      tempDest =  thisDestination.getDestinationsAtLevel(temp);
      if (ClientRtpMatching_Debug) {
	System.out.print("This destination would be replaced by " + tempDest);
      }
      temp++;
      if (ClientRtpMatching_Debug) {
	System.out.println(" for representation in a level(" + temp +
			   ") tree ");
      }
      rtpPropagate.propagateProfileChange(new
	RtpProfile(rtpProfile.getSubscription(), tempDest), temp, addProfile);
    }
  }

  /** This method return the destinations assocaited with an event that needs
      to be matched to the matching tree
      @return The destination as an INT
  */
  public ArrayList matchEvent(RtpEvent rtpEvent) {
    //System.out.println(moduleName + "Matching event with topic => " +
    //rtpEvent.getTopic());
    //Integer profileKey = new Integer(rtpEvent.getTopic());
    Long profileKey = new Long(rtpEvent.getTopic());
    ArrayList _computedDestinations =
      (ArrayList)profilesAndDestinations.get(profileKey);
    
    if (_computedDestinations == null) {
      //System.out.println(moduleName + "Computed destinations is null");
      Enumeration e = profilesAndDestinations.elements();

      //System.out.println(moduleName + "Listing registered profiles ");
      while (e.hasMoreElements()) {
	System.out.println(moduleName + e.nextElement());
      }
      return null;
    }


    //System.out.print("\n" + moduleName + "Computed Destinations = [");
    //for (int i = 0; i < _computedDestinations.size(); i++) {
    //System.out.print(_computedDestinations.get(i) + " ");
    //}
    //System.out.print("]\n");

    return _computedDestinations;
  }

  public static void main(String[] args) {
  }

}








